cboj-payments-prc-api

Description:

This API is used to pay program fees online.

Mulesoft Request:

Headers:

Mandatory Headers: x-channel-id, x-correlation-id, x-bank-id, client_id, client_secret

Optional Headers: x-sub-channel-id, x-user-id, Authorization, x-debug-flag, x-customer-id

Parameters:

URI Params: NA

Query Params: NA

Content-type: application/json

Body:

{
    "debitAccount": "4000127",
    "chargeAmount": "0.5"
}

Mulesoft Response:

Success Response: (200)

{
    "status": {
     "success": true,
     "code": "200",
     "arabicMessage": "تمت العملية بنجاح",
     "englishMessage": "The Operation has been Successfully Completed"
    },
    "response": {
     "transactionRefNumber" : "CHG2103985433"
    }
}

Sample Error Response:

Please refer the HOME page for all possible combinations of error response codes.

Note: The 'errorCode' and 'errorDescription' will be in the error response message only if 'x-debug-flag' is '1'

400 :

{
"status":
{
    "code": "T24003888",
    "reasonCode": "BadRequest",
    "arabicMessage": "Input data not found",
    "englishMessage": "Input data not found",
    "errorCode": "T24003888",
    "errorDescription": "INPUT MISSING"
  }
}